home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / disk / arcman15.lha / AMan.doc next >
Encoding:
Text File  |  1995-01-17  |  11.5 KB  |  290 lines
  1. /******************************************************************************\
  2. **                                                                            **
  3. **                         The Archives Manager 1.5                           **
  4. **                                                                            **
  5. **               (c) 1995 Martin Mares, MJSoft System Software                **
  6. **                                                                            **
  7. \******************************************************************************/
  8.  
  9.  
  10. Preface:
  11. --------
  12.  
  13.    AMan  and its documentation is Copyright (c) Martin Mares, MJSoft System
  14. Software, Prague, Czech Republic.
  15.  
  16.    This archive can be freely redistributed as long as all of its files are
  17. included  in  their  original  form  without  any  additions,  deletions or
  18. modifications  (excluding  addition  of other README-style files and icons)
  19. and  no  more  than  a  nominal  fee  is charged for its distribution.  All
  20. copyright notices in the programs and accompanying documentation files must
  21. remain intact.  It's especially forbidden to add various '.displayme' files
  22. and  BBS  advertisements.  This style of distribution is generally known as
  23. FREEWARE.
  24.  
  25.    Special  permission  is given to Fred Fish to distribute this program on
  26. his "Fish Disks".
  27.  
  28.    This  software  is provided "AS IS" without warranty of any kind, either
  29. expressed  or implied.  The author is not responsible for any damage caused
  30. by it.
  31.  
  32.  
  33. What's AMan?
  34. ------------
  35.  
  36.    AMan  is  a  small  utility designed for people having many disks filled
  37. with  archived  files  and  trying to know where is which file located.  It
  38. manages  a  list  of  files  (called  Archive Database), which contains the
  39. following  fields  for each archive:  Name, DiskName (displayed maximally 6
  40. characters  ->  try  to  name  your disks in style "A001" etc.), Length and
  41. Comment (usually containing the filenote of the archive).
  42.  
  43.    AMan is able to sort the files you want to extract by name of disk they're
  44. stored on and do many other interesting things. The most important one is
  45. probably the ADD command, which tries to tell you the best way to store
  46. new files to existing archive disks.
  47.  
  48.    These were the good news, but ... AMan is controlled completely by CLI-like
  49. commands (I plan to implement some GUI, but I have no time to do it \dots).
  50.  
  51.  
  52. Command line arguments:
  53. -----------------------
  54.  
  55. FILE/K - define name of default database (this database is loaded automatically
  56.          before executing the startup script (AMan.startup), default is Archive)
  57. HOST/S - start AREXX host
  58. PORT/K - define name of AREXX port used by the host (default is 'AMan')
  59.  
  60.  
  61. Data file format:
  62. -----------------
  63.  
  64.    Each file is described by one line:
  65.  
  66. <name>|<diskname>|<size>|<datestamp>|<comment>
  67.  
  68.    Last few lines contain free space informations:
  69.  
  70. :<diskname>|<freebytes>          for FFS disks
  71. ::<diskname>|<freebytes>         for OFS disks
  72.  
  73.  
  74. Commands:
  75. ---------
  76.  
  77.    Each command may be followed by standard AmigaDOS-style standard output
  78. redirection (>file) placed before its arguments. >#n redirects to window
  79. of given number.
  80.  
  81. ? or HELP - display brief list of commands
  82.  
  83. QUIT - exit without saving the database. If the database has been changed,
  84. you will be asked if you really want to quit.
  85.  
  86. EXIT - exit. Save the database if it's been changed.
  87.  
  88. SAVE [[AS] <filename>] - save the database. The file name will be used as new
  89. default.
  90.  
  91. LOAD [[FROM] <filename>] - (re)load the database. The file name will be used as
  92. new default.
  93.  
  94. MERGE [FROM] <filename> - join specified database with current one.
  95.  
  96. STATUS [FULL] - display number of records, number of disks and number of changes
  97. in the database. STATUS FULL displays some internal information used for
  98. debugging of memory allocation routines.
  99.  
  100. ENTER <name> <diskname> <comment> <size> [<date>] - manual addition of record.
  101. If the date is not specified, current one will be used.
  102.  
  103. LIST [<filter>] [FULL] - list all files matching the filter expression (see
  104. below).  If no filter is given, all files will be displayed.  The asterisk
  105. ('*') character on the left side of the listing says that the record is
  106. selected. The FULL switch forces LIST to display all items in their full form
  107. instead of shortening them when not enough room on the line is available.
  108.  
  109. STAT [<filter>] - display total size of selected records.
  110.  
  111. SELECT <filter> - select all files matching the filter expression.
  112.  
  113. DESELECT <filter> - deselect all files matching the filter expression.
  114.  
  115. INVERT <filter> - invert selection of all files matching the filter expression.
  116.  
  117. RESELECT <filter> - select all files matching the filter expression. All other
  118. files will be deselected.
  119.  
  120. DELETE <filter> [AUTO] - delete all files matching the filter expression. You
  121. will be asked to confirm this operation. The AUTO option says that you want
  122. to delete not only the records in the database, but also the real files.
  123.  
  124. SCAN <drive> [TODAY] - scan files in specified directory/drive and add them
  125. to the database. The TODAY switch forces the date to be rewritten by the
  126. current one.
  127.  
  128. EXTRACT <filter> [TO <dir>] - list all files matching the filter expression
  129. sorted by disks they are stored on.  This function makes extracting of
  130. large amount of files significantly simpler.
  131.    If you specify a destination directory using the TO parameter, all files
  132. are automatically copied into it.  In this case, the date/time of file
  133. creation is set to current one.  If the directory doesn't exist, it is
  134. created.
  135.  
  136. FIND <pattern> [SEL] - list all files containing specified pattern as a
  137. part of their file name or comment.  Option SEL allows marking of all
  138. matching files as selected.
  139.  
  140. DISKS [CLEANUP] [STAT] [NOFULL] - list disks (the output contains disk name,
  141. free space and number of files on the disk).
  142.   CLEANUP = delete all disks with 0 files on them.
  143.   STAT = display only statistics, don't show each entry
  144.   NOFULL = exclude full disks
  145.  
  146. CHECK - check consistence of archive. This function displays warnings about
  147. duplicated file names and empty disks. It's recommended to use this function
  148. after all large manipulations with the archive (e.g. adding of larger amount
  149. of files).
  150.  
  151. ADD <srcdir> [TOUCH] [COPY] - probably the most powerful function of this
  152. program.  It scans all files in specified directory and tries to place them
  153. on the archive disks in optimal way.  The list of pairs [disk,file] is
  154. sorted by disk, therefore you can add the files easily.  The INFO option is
  155. used mostly for debugging, but you can use it to get more information about
  156. the process.
  157.    The  TOUCH option forces setting of date/time of all added files to current
  158. date/time.
  159.    The COPY option causes automatic copying of all added files to backup disks.
  160. Date/time of creation of the file is set to current date/time.
  161.    The DirCache filesystem (V39+) is not supported, because it usually
  162. isn't used on backup disks.
  163.    Sets selection flag of all rescanned files.
  164.  
  165. REPORT [<filter>] - create a human-readable dump of archive contents. It
  166. contains only the file names, sizes and comments. Used mostly with output
  167. redirection.
  168.  
  169. SCRIPT <name> - execute script (AMan.startup is executed during AMan startup)
  170.  
  171. ECHO <string> - display a string
  172.  
  173. ALIAS <name> <def> - define an alias, ! means "insert the arguments here"
  174.  
  175. ALIAS <name> - remove alias
  176.  
  177. ; <anything> - comment
  178.  
  179. OPENW <nr> [<filename>] - open window
  180.  
  181. CLOSEW ( <nr> | ALL ) - close window
  182.  
  183. HOST [<portname>] [SHOW] - start REXX Host mode (using given port name
  184. or 'AMan' if no name is specified). The SHOW options causes displaying
  185. of all commands being executed and their error messages.
  186.  
  187. GENDISK <basename> <numdisks> [OFS] [82TRK] - add new (fictive) disks
  188. to the database. Default is standard FFS disk - may be overriden to OFS
  189. or to the 82-track format by appropriate switches.
  190.  
  191. ! <shell command> - execute a shell command. AMan-style redirection can be
  192. placed between "!" and the command. CTRL-C doesn't work. (in this version,
  193. this feature is implemented by calling dos/Execute(), which has several
  194. disadvantages => it should be remade in some future version...)
  195.    If you want to call shell commands from ALIASes, you can use the EXECUTE
  196. command, which is a synonym for "!".
  197.  
  198. Filter expressions:
  199. -------------------
  200.  
  201.     ALL/S - do for all files
  202.     SEL/S - do for selected files
  203.      NAME - do for files which name matches given pattern. Default=#?
  204.      DISK - do for files which disk name matches given pattern. Default=#?
  205.   COMMENT - do for files which comment matches given pattern. Default=#?
  206.    LESS/K - do for files which size is less than given number
  207. GREATER/K - do for files which size is greater than given number
  208.  BEFORE/K - do for files which date is less than given one
  209.   AFTER/K - do for files which date is greater than given one
  210.    DATE/K - do for files which date is equal to given one
  211.    FROM/K - do for all files from given file list. The file list is a file
  212.             containing pure file names on separate lines or output from the
  213.             REPORT command.
  214.  
  215.    ALL/SEL, NAME, DISK, COMMENT, LESS/GREATER, BEFORE/AFTER/DATE and FROM
  216. can be freely combined.
  217.  
  218. Standard startup script:
  219. ------------------------
  220.  
  221.    Standard distribution package contains also an example startup file
  222. (AMan.startup), which is executed by the program during its startup and
  223. contains some useful aliases:
  224.  
  225.   s    scan diskette in DF0:
  226.   end    execute the End.AMan script (generates a report to ArcDir and exits)
  227.   w    save current database
  228.   x    exit
  229.   xx    quit
  230.   c    check
  231.   a    add work:arch (usually called to check if the files fit on the disks
  232.             before using aa)
  233.   aa    add work:arch copy
  234.   f    use find to search for given pattern
  235.   ff    same as f, but selects found records (usually used after successful f)
  236.   e    extract selected records to work:extr
  237.  
  238. Things to be implemented:
  239. -------------------------
  240.  
  241.   - some new commands callable from REXX scripts
  242.   - faster reading/saving of database files
  243.   - menu selection / menu mode ?
  244.   - DOpus interface
  245.  
  246. History:
  247. --------
  248.  
  249. 140493 FIND: SEL option
  250. 140493 LOAD: all loaded records are automatically deselected
  251. 140493 ADD: TOUCH option
  252. 150493 Repaired bug in LOAD causing 81000009 alerts.
  253. 230493 DISKS displays total size
  254. 230493 Empty date is replaced by current one (-> LIST AFTER "" etc.)
  255. 230493 STAT added
  256. 110593 Multiple OPENW doesn't leave lost windows
  257. 060793 ADD: repaired incorrect calculation of block size; INFO removed
  258. 060793 EXTRACT and ADD sped up
  259. 100793 DISKS: added STAT and NOFULL functions
  260. 100793 SAVE: AS/K changed to AS
  261. 100793 Added AREXX host
  262. 100793 LOAD now resets change counter
  263. 100793 -- released as version 1.1ß --
  264. 200793 Added GENDISK command
  265. 200793 Fixed another bug in ADD
  266. 200793 ADD: now reports required number of additional disks
  267. 200793 -- released as version 1.2ß --
  268. 121293 ! <command> executes a shell command
  269. 121293 filter expression FROM/K accepts files generated by REPORT
  270. 121293 EXTRACT does secondary sorting by file names
  271. 121293 EXTRACT and ADD are able to copy the files automatically
  272. 121293 Warning displayed when scanning disk with unknown filesystem
  273. 121293 -- released as version 1.3 --
  274. 110194 DELETE is able to perform automatic deletion of files (the AUTO switch)
  275. 110194 GENDISK: option 82TRK added
  276. 110194 repaired extract to current directory
  277. 110194 ADD: reserved 1 block for FileSystem bug (there's a bug in some ROM File-
  278.     systems causing disk to be unfillable - there must be at lease 1 block
  279.     free)
  280. 110194 -- released as version 1.4 --
  281. 160194 Maximal length of comment increased to 64
  282. 160194 Added a FULL option of LIST command that allows all fields to be displayed
  283.        in full, non-shortened form.
  284. 160194 -- released as version 1.5 --
  285.  
  286. Last words:
  287. -----------
  288.  
  289.    - send your bug reports and ideas to mjsoft@k332.feld.cvut.cz
  290.